 | Back to Events |
 | Up to Table of Contents |
|
|
| Used By: | Timer objects. |
| Description: |
This property controls how long (in milliseconds) the Timer object waits before it triggers an event. Specify a number greater than 0. If you leave the default value of 0, this will effectively disable the timer object. The RepeatCount property determines how many times you want the Alarm event to go off.
As an example, you could set the AlarmInterval property to 200 so that an Alarm event occurs every 200 milliseconds. Each time the event occurs, you could set up the application so that a different graphic displays in a Graphic object. |
| See Also: | RepeatCount property |
| Used By: | Check Box objects, Combo Box objects, Graphic objects, List Box objects, Page objects, Push Button objects, Radio Button objects, Text objects, and Text field objects. |
| Description: |
This property controls the background color of the object. The Value field lets you display the Color dialog box, from which you can choose a color or create a custom one. When you click OK in the Color dialog box, a value (called an RGB value) that represents the selected color is returned to the Value field.
RGB values are made up of three numbers, from 0-255, separated by commas. Each number represents the intensity of Red, Green, and Blue used in the color. For example, 0,0,0 represents black and 255,255,255 represents white. Note: Background color on certain objects is platform specific. For example, the Background color assigned to a Push Button object will not change the background color in platforms that support Windows, but it will change in platforms that support UNIX. For more information on using the Color dialog box, see Appendix A. |
| Used By: | Picture Push Button objects. |
| Description: |
This property lets you choose from three states for the button's appearance. The three states are: Up, UpDown, and UpDownDisabled. You must have an image for each state if you choose UpDown or UpDownDisabled. You set the graphic file you want to use via the Filename property. All images must be of equal size and in one file, as shown in the following example:
Up Down Disabled If the ButtonStyle is Up, the entire graphic is used.
|
| See Also: | Enabled property. |
| Used By: | Check Box objects and Radio Button objects. |
| Description: | This property, set to True or False, lets you control whether or not the object is checked (i.e., has a check mark next to it) by default. The user is able to toggle the value at run time. |
| Used By: | Graphic objects. |
| Description: |
This property contains the number of the cell that is currently selected in an image strip. To indicate which cell you want to begin the animation with, set the CurrentCell property to the appropriate number. For example, if you want to start with the third cell, set CurrentCell to 3. In a grid of rows and columns, the cells are numbered as shown in the following sample figure.
As an example, this property is useful if you want to begin an animation with a particular cell in the image strip. For detailed information on image strips, see Chapter 6. |
| See Also: | NumberOfCells, NumberOfColumns, NumberOfRows, and FileName properties |
| Used By: | Graphic objects and Text objects. |
| Description: | This property lets you choose the effect to be used when the object is first created and when the object's Filename property is changed at runtime. The Value field lets you open the DisplayEffect Properties dialog box where you can select an effect and its modifiers (such as direction and speed). |
| Used By: | Graphic objects and Page Objects. |
| Description: | This property determines how a graphic file appears in the object. The following drop-down list options are available through the Value field: |
|
|
Center - For Page objects only. The graphic is centered on the Page background. |
|
|
Clip - The object contains as much of the graphic as is possible, starting with the upper-left corner. If the object is smaller than the graphic some of the graphic will be hidden from view. If the object is larger than the graphic some white space will be visible where the graphic doesn't fill the object. |
|
|
Tile - The graphic is taken in its original size, and is repeated as many times as necessary to fill the area of the object. |
|
|
SizeByGraphic - For Graphic objects only - The object size automatically changes so that it precisely surrounds the entire graphic. |
| Used By: | Hotspot object. |
| Description: |
This property lets you choose the effect to use when the user interacts with a hotspot (for example, by clicking on it). The Value field drop-down list lets you select from the following items:
None - There is no visual effect. Outline - An outline appears around the border of the object. OutlineFlash - A flashing outline appears around the border of the object. Highlight - The entire object is highlighted. HightlightFlash - The entire object is highlighted and flashes. |
| See Also: | DisplayEffect, HowToHide, HowToShow, and the Visible properties. |
| Used By: | Check Box objects, Combo Box objects, List Box objects, Push Button objects, Radio Button objects, Text objects, and Text Field objects. |
| Description: | This property specifies the font characteristics of text. The Value field lets you open the Font dialog box to select the characteristics you want to use. See Appendix A, Common Dialog Boxes, for more information on how to use the Font dialog box. |
| Used By: | The Application. |
| Description: | This method directs the Application to display a specified page when a designated event happens. The Value field lets you choose from a list of all of the pages within the current application. As an example, a user could click on a Push Button object to go to a different page in the application. |
| Used By: | Browser objects. |
| Description: | This method directs the Browser to display a different Web page. Use the URL property to specify the desired URL. The GoToURL() method does not take any parameters. |
| Used By: | All objects that can be visible at runtime. |
| Description: | This property resets the height of the object in pixels. Specify a whole number greater than zero. |
| See Also: | Width property. |
| Used By: | All objects that can be visible at runtime. |
| Description: |
This property lets you choose how to hide an object that you are making invisible with the Visible property. The Value field lets you open the HowToHide dialog box which lets you choose how you want the object to disappear.
Choose a Type: None or SlideOut. SlideOut causes the object to slide from the current position, in a particular direction, to beyond the edge of the window. Choose a Direction: For example, Left causes the object to slide to or from the left middle side of the window, BottomRight causes the object to slide to or from the bottom right corner, and Random causes the object to slide to or from any one of the possible directions. Choose a Speed: The object can slide at a range of speeds from VerySlow to VeryFast. |
| See Also: | HowToShow and Visible properties. |
| Used By: | All objects that can be visible at runtime. |
| Description: |
This property does the opposite of the HowToHide property. It lets you choose how to hide an object that you are making visible with the Visible property. The Value field lets you open the HowToShow dialog box which lets you choose how you want the object to come into view. For information on how to select from the available options, see the HowToHide property.
Choose a Type: SlideIn or None. SlideIn causes the object to slide from a particular direction beyond the edge of the window to the current position of the object. Choose a Direction: For example, Left causes the object to slide to or from the left middle side of the window, BottomRight causes the object to slide to or from the bottom right corner, and Random causes the object to slide to or from any one of the possible directions. Choose a Speed: The object can slide at a range of speeds from VerySlow to VeryFast. |
| See Also: | HowToHide and Visible properties. |
| Used By: | Combo Box objects and List Box objects. |
| Description: |
This property sets the items that appear in a Combo Box or List Box. The Value field lets you open the ItemList Property dialog box so that you can easily specify the items you want to list. Type items in the list, pressing Return after each item. Optionally, set the SelectedItemNumber field to the number of the item that you want to be selected by default. (The top item is number 1, the next is number 2, and so on.
When you close the ItemList Property dialog box, it returns the information you entered to the Value field. Each item is separated from the next by a semicolon (;). |
| See Also: | SelectedItemData and SelectedItemNumber properties. |
| Used By: | Check Box objects, Push Button objects, and Radio Button objects. |
| Description: | This property lets you specify the text that labels a Check Box, Push Button or Radio Button object. |
| Used By: | Browser objects. |
| Description: | This property lets you specify the text that appears in the status bar of your Web browser. To actually launch the message, you must set the EchoMessage() method. |
| See Also: | EchoMessage() method. |
| Used By: | Check Box objects, Combo objects, Graphic objects, Hotspot objects, List Box objects, Page objects, Picture Push Button objects, Push Button objects, Radio button, objects, Text objects, and Text Field objects. |
| Description: | This method lets you move and size the object. The Value field lets you open the MoveAndSize() Parameters dialog box where you can select an X Position and Y Position (to indicate the position of the object's top left corner) and a Width and Height (in pixels). You can also move the object relative to its current position by using a plus or minus sign before the number. For example, entering " +100" in the X value field will move the object 100 pixels to the right of its current position. |
| Used By: | All objects. |
| Description: |
This property lets you change the name of an object. This name is not visible at runtime; it is simply for identification purposes. Hint: You can also change an object's name by double-clicking on it in the Object List, typing a new name, and pressing Return.
Important: You should set the Name property of an object when you first create an object. If you change the name of an object that has already been referenced in a To Do list, you will have to update the To Do list to reflect the new name. Name references will not be updated automatically. |
| Used By: | Browser objects. |
| Description: | This property, set to True or False, determines whether to launch a new window for the URL filename listed in the Browser object. The URL property determines the http or ftp Internet address that will appear. The GoToURL() method directs the object to display the specified address. |
| See Also: | URL property and GoToURL() method. |
| Used By: | Graphic objects. |
| Description: | This method displays the next sequential cell in an image strip graphic file when the specified event occurs. This method does not take any parameters in its value field. |
| Used By: | The Application. |
| Description: | This method displays the next sequential page in an application when the specified event occurs. This method does not take any parameters in its value field. |
| Used By: | Graphic objects. |
| Description: |
Use this property to indicate the number of cells that are used in an image strip for a cycling graphic.
Note that because some cells at the end of the file may be unused, this value is sometimes smaller than the total number of cells in the file. For example, even if an image strip has four columns and four rows (with a total of 16 cells), you might specify the value 15, if only 15 of the cells contain images. |
| See Also: | NumberOfColumns, CurrentCell, NumberOfRows, and the FileName properties. |
| Used By: | Graphic objects. |
| Description: | Use this property to indicate the number of columns in an image strip graphic file. Jamba uses this value (along with the NumberOfRows and NumberOfCells properties) to divide the graphic file into the appropriate number of images. |
| See Also: | NumberOfCells, CurrentCell, and NumberOfRows properties. |
| Used By: | Graphic objects. |
| Description: | Use this property to indicate the number of rows in an image strip graphic file. Jamba uses this value (along with the NumberOfColumns and NumberOfCells properties) to divide the graphic file into the appropriate number of images. |
| See Also: | NumberOfCells, NumberOfColumns, and CurrentCell properties. |
| Used By: | Text objects. |
| Description: | This method advances the user's view field in a Text object down by one page. A page in a Text object is equal to the number of lines visible in the object. So, if five lines are visible in the Text object, the next five lines will display when the specified event occurs. This method does not take any parameters in its value field. |
| See Also: | PageUp(), ScrollDown(), ScrollEnd(), ScrollHome(), and ScrollUp() Methods. |
| Used By: | Text objects. |
| Description: | This method advances the user's view field in a Text object up by one page. A page in a Text object is equal to the number of lines visible in the object. So, if five lines are visible in the Text object, the previous five lines will display when the specified event occurs. This method does not take any parameters in its value field. |
| See Also: | PageDown(), ScrollDown(), ScrollEnd(), ScrollHome(), and ScrollUp() Methods. |
| Used By: | CGI objects and JavaTM Extension objects. |
| Description: | This property lets you send one or more values from your application to a CGI program. Any values that you need to send must be expressed using the Object.Property syntax. For example, consider a CGI program that is set up to evaluate the state of CheckBox1 in your application. You would set the ParameterList property to CheckBox1.Checked. This would send either the value True or False to the CGI program, depending on the state of the object. The CGI object can then evaluate the received value and send back a response if necessary. If you need to send more than one value, separate each ObjectName.Property item from the next using a semicolon (;). |
| See Also: | Response property |
| Used By: | Audio objects. |
| Description: | This method plays an Audio file when the specified event occurs. This method does not take any parameters in its value field. The audio file to play is specified in the Filename property. |
| See Also: | Stop() method, PlayCount property. |
| Used By: | Audio objects. |
| Description: | This property, set to one or infinite, controls how many times a specified audio file plays. The default is 1. |
| See Also: | Stop() and Play() methods. |
| Used By: | Graphic objects. |
| Description: | This method displays the previous sequential cell in an image strip graphic when the specified event occurs. This method does not take any parameters in its value field. |
| See Also: | NextCell() method. |
| Used By: | The Application. |
| Description: | This method displays the previous sequential page in an application when the specified event occurs. This method does not take any parameters in its value field. |
| See Also: | NextPage() method. |
| Used By: | Timer objects. |
| Description: | This property sets how many times you want an Alarm event to go off. It is typically used with image strips and their cells to animate a graphic. You could set up a To Do List so that every time the Alarm event goes off, it triggers the NextCell() method to display the next cell in the image strip. The RepeatCount property is equal to the number of cells in your image strip multiplied by the number of times you want to show the entire file. You may set the value to a specific number or set the value to infinite play. |
| See Also: | NextCell() method. |
| Used By: | CGI objects. |
| Description: | This property determines whether the CGI object can receive a return value from a CGI program. The default is True which causes the CGI object to expect information back from the CGI program. |
| Used By: | CGI objects. |
| Description: | This method controls when a CGI object starts. When the object runs, it sends the values in the ParameterList property to the appropriate CGI program. This method does not take any parameters in its value field. |
| See Also: | ParameterList Property. |
| Used By: | Text objects. |
| Description: | This method lets a user scroll down through a text block that appears in a Text object. Each time the specified event occurs, an additional line of text appears. This method does not take any parameters in its value field. |
| See Also: | PageDown(), PageUp(), ScrollEnd(), ScrollHome(), and ScrollUp() Methods |
| Used By: | Text objects. |
| Description: | This method lets a user go to the end of a text block that appears in a Text object every time the specified event occurs. This method does not take any parameters in its value field. |
| See Also: | PageDown(), PageUp(), ScrollDown(), ScrollHome(), and ScrollUp() Methods |
| Used By: | Text objects. |
| Description: | This method lets a user go to the beginning of a text block that appears in a Text object every time the specified event occurs. This method does not take any parameters in its value field. |
| See Also: | PageDown(), PageUp(), ScrollDown(), ScrollEnd(), and ScrollUp() Methods |
| Used By: | Text objects. |
| Description: | This method lets a user scroll up through a text block that appears in a Text object. Each time the specified event occurs, an additional line of text appears. This method does not take any parameters in its value field. |
| See Also: | PageDown(), PageUp(), ScrollDown(), ScrollEnd(), and ScrollHome() Methods |
| Used By: | Combo Box objects and List Box objects. |
| Description: |
This property is set to the item that the user selects. For example, if the user clicks on "blue," SelectedItemData is set to blue.
You can use the ObjectName.Property syntax to use the selected value to affect another object (or the list box itself). For example, if the user selects the filename lion.gif from a list of possible graphic files displayed in ListBox1, you can use that value to set the FileName property of a Graphic object. You would set up the ListBox1's To Do list so that when a Select event occurs, the Graphic object's Filename property is set to ListBox1.SelectedItemData (which equals the selected filename). Another typical way to manipulate the value in the SelectedItemData property is to send it to a CGI program for evaluation or storage. For information on how to send a value to a CGI program, see the ParameterList property. See Chapter 2 for more information on the Object.Property syntax. |
| See Also: | SelectedItemNumber property and the ParameterList property. |
| Used By: | Combo Box objects and List Box objects. |
| Description: |
This property is set to the number of the item that is currently selected. The first (topmost) item in a list is 1, the second item is 2, and so on.
Like the SelectedItemData property, a typical way to manipulate the value in the SelectedItemNumber property is to send it to a CGI program for evaluation or storage. For information on how to send a value to a CGI program, see the ParameterList property. |
| See Also: | SelectedItemData property and the ParameterList property. |
| Used By: | All visible objects. |
| Description: | This method causes an object to move to a different position when a specified event occurs. The Value field lets you open the SlideTo() Parameters dialog box where you can select an X,Y position in pixels and a speed that ranges from VerySlow to VeryFast. You can also set this method so that the object moves to a position relative to its current position. You do this using the plus or minus sign. For example, setting a value of +100 for X will move the object 100 pixels to the right of its current position. |
| Used By: | Audio objects, Timer objects and CGI objects. |
| Description: | This method stops an audio file from playing or stops a CGI object from running when a specified event occurs. This method does not take any parameters in its value field. |
| See Also: | Play() method, Stop()method, and PlayCount property. |
| Used By: | Text objects and Text Field objects. |
| Description: |
This property has two uses. First, it lets you specify text that you want to display in the object. (The Filename property also allows you to specify an entire text file you want to display within the object.)
Second, you can use the Text property to determine what the user typed. When the user enters text, the Text property is set to that input. For example, if the user types "Stockholm", the Text property is set to Stockholm. Your application can use the ParameterList property to send the Text property value to a CGI program for evaluation and/or storage. Optionally, the CGI program can return a value to the application so that another Text object can display a message such as "That is correct." |
| Used By: | Check Box, Combo Box, List Box, Radio Button, Text Field and Text objects, and Push Button objects. |
| Description: |
This property sets the color of text that appears in the object. The Value field lets you open the Color dialog box where you can select a color. When you close the dialog box a value (called an RGB value) that represents the selected color is returned to the Value field. For more information on RGB values, see the description of the BackgroundColor property.
Note: Background color on certain objects is platform specific. For example, the Background color assigned to a Push Button object will not change the background color in platforms that support Windows, but it will change in platforms that support UNIX. For more information on using the Color dialog box, see Appendix A. |
| See Also: | Transparent property. |
| Used By: | Graphic objects and Text objects. |
| Description: | This property, set to True or False, determines whether the color selected in the TransparentColor property of an object is solid or transparent. |
| See Also: | TransparentColor property. |
| Used By: | Graphic objects. |
| Description: | This property specifies which color within an object is transparent. The Transparent property determines whether the color is currently transparent or not. The Value field lets you open the Color dialog box where you can select a color. When you close the dialog box a value (called an RGB value) that represents the selected color is returned to the Value field. For more information on RGB values, see the BackgroundColor property. |
| See Also: | Transparent property. |
| Used By: | The Application. |
| Description: |
This method triggers an event. In the To Do List, set the Object field to Application, set the What To Do field to TriggerEvent() and set the Value field to the name of the object and event you want to trigger. Use the syntax ObjectName,EventName when specifying information in the Value field.
One way to use this method is to cause object A to execute its To Do List when object B receives an event. For example, you can use this feature to make PushButton1 execute its To Do List when PushButton2 is clicked. In effect, PushButton1 is behaving as if it was clicked when PushButton2 is clicked. The To Do item for PushButton2 would contain the following: Object is set to Application, What To Do is set to TriggerEvent(), and Value is set to PushButton1,Click. Another way to use the TriggerEvent() method is to allow a CGI program to trigger an event when it returns information to the Jamba application. For more information, see the description of the CGI object in Chapter 6. |
| Used By: | Browser objects. |
| Description: | This property determines the http or ftp Internet address that appears when a specified event occurs. The NewWindow property determines whether or not to launch a new window for the listed URL. |
| See Also | Filename and NewWindow properties, GoToURL() method. |
| Used By: | Check Box objects, Combo objects, Graphic objects, Hotspot objects, List Box objects, Page objects, Picture Push Button objects, Push Button objects, Radio button, objects, Text objects, and Text Field objects. |
| Description: | This property resets the width of the object in pixels. Specify a number greater than 0. |
| See Also: | Height property. |
| Used By: | Check Box objects, Combo objects, Graphic objects, Hotspot objects, List Box objects, Page objects, Picture Push Button objects, Push Button objects, Radio button, objects, Text objects, and Text Field objects. |
| Description: | This property resets the position of the object along the X (i.e., horizontal) axis in pixels within the Page Layout editor and at runtime. 0 is the left side of the screen. Specify a whole number. |
| See Also: | Y property. |
| Used By: | Check Box objects, Combo objects, Graphic objects, Hotspot objects, List Box objects, Page objects, Picture Push Button objects, Push Button objects, Radio button, objects, Text objects, and Text Field objects. |
| Description: | This property resets the position of the object along the Y (i.e., vertical) axis in pixels within the Page Layout editor and at runtime. 0 is the top of the screen. Specify a whole number. |
| See Also: | X property. |
|
|
